/*
 * Copyright 2008 - 2009 Lars Heuer (heuer[at]semagia.com). All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.semagia.atomico.server;

import com.semagia.atomico.dm.IAuthor;
import com.semagia.atomico.server.storage.SortOrder;

/**
 * Immutable configuration.
 * <p>
 * Implementations of this interface are meant to be thread-safe.
 * </p>
 * 
 * @author Lars Heuer (heuer[at]semagia.com) <a href="http://www.semagia.com/">Semagia</a>
 * @version $Rev: 107 $ - $Date: 2010-10-30 00:04:24 +0000 (Sat, 30 Oct 2010) $
 */
public interface IConfiguration {

    /**
     * Returns the publisher of the feed.
     *
     * @return The name of the publisher / author not <tt>null</tt>.
     */
    @Deprecated
    public String getAuthorName();

    /**
     * Returns the publisher's e-mail address or <tt>null</tt> if the author
     * has no e-mail address.
     *
     * @return The e-mail address or <tt>null</tt>.
     */
    @Deprecated
    public String getAuthorEmail();

    /**
     * Returns the publisher's IRI or <tt>null</tt> if the author has no IRI.
     *
     * @return The absolute IRI or <tt>null</tt>.
     */
    @Deprecated
    public String getAuthorIRI();

    /**
     * Returns the publisher of the feed.
     *
     * @return The publisher of the feed, never {@code null}.
     */
    public IAuthor getAuthor();

    /**
     * Returns the title for the overview feed, i.e. "Overview" or "Topic Maps".
     *
     * @return The title for the overview feed.
     */
    public String getOverviewFeedTitle();

    /**
     * Returns the title for a collection feed.
     *
     * @param collectionTitle The title of the collection.
     * @return The title for a collection feed.
     */
    public String getCollectionFeedTitle(String collectionTitle);

    /**
     * Returns the title for a snapshots feed.
     *
     * @param collectionTitle The title of the collection.
     * @return The title for a snapshots feed.
     */
    public String getSnapshotFeedTitle(String collectionTitle);

    /**
     * Returns the title for a fragments feed.
     *
     * @param collectionTitle The title of the collection.
     * @return The title for a fragments feed.
     */
    public String getFragmentFeedTitle(String collectionTitle);

    /**
     * Returns the title for the collection feed's snapshots entry, i.e. 
     * "Snapshots".
     *
     * @param collectionTitle The title of the collection.
     * @return The entry title.
     */
    public String getSnapshotsEntryTitle(String collectionTitle);

    /**
     * Returns the title for the collection feed's fragment entry, i.e. 
     * "Fragments".
     *
     * @param collectionTitle The title of the collection.
     * @return The entry title.
     */
    public String getFragmentsEntryTitle(String collectionTitle);

    /**
     * Returns the sort order for the collections in the overview feed.
     *
     * @return A sort order.
     */
    public SortOrder getCollectionSortOrder();

    /**
     * Returns the sort order for the snapshots in the snapshots feed.
     *
     * @return A sort order.
     */
    @Deprecated
    public SortOrder getSnapshotSortOrder();

    /**
     * Returns the sort order for the fragments in the fragments feed.
     *
     * @return A sort order.
     */
    @Deprecated
    public SortOrder getFragmentSortOrder();

}
